/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.internal.ui.refactoring.actions;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.ui.IWorkbenchSite;
import org.eclipse.ui.PlatformUI;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.ISourceRange;
import org.eclipse.jdt.core.ITypeRoot;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.refactoring.IJavaRefactorings;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringAvailabilityTester;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringExecutionStarter;
import org.eclipse.jdt.internal.corext.refactoring.codingspectator.RefactoringGlobalStore;
import org.eclipse.jdt.internal.corext.refactoring.util.JavaElementUtil;
import org.eclipse.jdt.internal.corext.refactoring.util.RefactoringASTParser;
import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
import org.eclipse.jdt.ui.actions.SelectionDispatchAction;
import org.eclipse.jdt.ui.actions.codingspectator.UnavailableRefactoringLogger;
import org.eclipse.jdt.internal.ui.IJavaHelpContextIds;
import org.eclipse.jdt.internal.ui.JavaPlugin;
import org.eclipse.jdt.internal.ui.actions.ActionUtil;
import org.eclipse.jdt.internal.ui.actions.SelectionConverter;
import org.eclipse.jdt.internal.ui.javaeditor.EditorUtility;
import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor;
import org.eclipse.jdt.internal.ui.javaeditor.JavaTextSelection;
import org.eclipse.jdt.internal.ui.refactoring.RefactoringMessages;
import org.eclipse.jdt.internal.ui.util.ExceptionHandler;
/**
* Inlines a method.
*
* <p>
* This class may be instantiated; it is not intended to be subclassed.
* </p>
*
* @author Mohsen Vakilian, nchen - Captured a possible unavailability of the inline method
* refactoring and structured selections. Also, initialized the global store of refactorings
* at the beginning of the run methods.
*/
public class InlineMethodAction extends SelectionDispatchAction {
private JavaEditor fEditor;
/**
* Note: This constructor is for internal use only. Clients should not call this constructor.
*
* @param editor the java editor
*/
public InlineMethodAction(JavaEditor editor) {
this(editor.getEditorSite());
fEditor= editor;
setEnabled(SelectionConverter.canOperateOn(fEditor));
}
public InlineMethodAction(IWorkbenchSite site) {
super(site);
setText(RefactoringMessages.InlineMethodAction_inline_Method);
PlatformUI.getWorkbench().getHelpSystem().setHelp(this, IJavaHelpContextIds.INLINE_ACTION);
}
//---- structured selection ----------------------------------------------
/*
* @see SelectionDispatchAction#selectionChanged(IStructuredSelection)
*/
@Override
public void selectionChanged(IStructuredSelection selection) {
try {
setEnabled(RefactoringAvailabilityTester.isInlineMethodAvailable(selection));
} catch (JavaModelException e) {
if (JavaModelUtil.isExceptionToBeLogged(e))
JavaPlugin.log(e);
}
}
/*
* @see SelectionDispatchAction#run(IStructuredSelection)
*/
@Override
public void run(IStructuredSelection selection) {
try {
// CODINGSPECTATOR
RefactoringGlobalStore.getNewInstance().setStructuredSelection(selection);
Assert.isTrue(RefactoringAvailabilityTester.isInlineMethodAvailable(selection));
IMethod method= (IMethod) selection.getFirstElement();
ISourceRange nameRange= method.getNameRange();
run(nameRange.getOffset(), nameRange.getLength(), method.getTypeRoot());
} catch (JavaModelException e) {
ExceptionHandler.handle(e, getShell(), RefactoringMessages.InlineMethodAction_dialog_title, RefactoringMessages.InlineMethodAction_unexpected_exception);
}
}
/*
* @see SelectionDispatchAction#selectionChanged(ITextSelection)
*/
@Override
public void selectionChanged(ITextSelection selection) {
setEnabled(true);
}
/*
* @see org.eclipse.jdt.ui.actions.SelectionDispatchAction#selectionChanged(org.eclipse.jdt.internal.ui.javaeditor.JavaTextSelection)
*/
@Override
public void selectionChanged(JavaTextSelection selection) {
try {
setEnabled(RefactoringAvailabilityTester.isInlineMethodAvailable(selection));
} catch (JavaModelException e) {
setEnabled(false);
}
}
/*
* @see org.eclipse.jdt.ui.actions.SelectionDispatchAction#run(org.eclipse.jface.text.ITextSelection)
*/
@Override
public void run(ITextSelection selection) {
//CODINGSPECTATOR
RefactoringGlobalStore.getNewInstance().setEditorSelectionInfo(EditorUtility.getEditorInputJavaElement(fEditor, false), selection);
ITypeRoot typeRoot= SelectionConverter.getInput(fEditor);
if (typeRoot == null)
return;
if (!JavaElementUtil.isSourceAvailable(typeRoot))
return;
run(selection.getOffset(), selection.getLength(), typeRoot);
}
private void run(int offset, int length, ITypeRoot typeRoot) {
if (!ActionUtil.isEditable(fEditor, getShell(), typeRoot))
return;
CompilationUnit compilationUnit= RefactoringASTParser.parseWithASTProvider(typeRoot, true, null);
if (!RefactoringExecutionStarter.startInlineMethodRefactoring(typeRoot, compilationUnit, offset, length, getShell())) {
//CODINGSPECTATOR: I don't know under what circumstances the user hits this case of unavailability. But, I record the refactoring descriptor just to be safe.
UnavailableRefactoringLogger.logUnavailableRefactoringEvent(IJavaRefactorings.INLINE_METHOD, RefactoringMessages.InlineMethodAction_no_method_invocation_or_declaration_selected);
MessageDialog.openInformation(getShell(), RefactoringMessages.InlineMethodAction_dialog_title, RefactoringMessages.InlineMethodAction_no_method_invocation_or_declaration_selected);
}
}
public boolean tryInlineMethod(ITypeRoot typeRoot, CompilationUnit node, ITextSelection selection, Shell shell) {
return RefactoringExecutionStarter.startInlineMethodRefactoring(typeRoot, node, selection.getOffset(), selection.getLength(), shell);
}
}